home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 / Ham Radio 2000.iso / ham2000 / packet / liu95bt2 / ports.doc < prev    next >
Text File  |  1993-11-25  |  13KB  |  553 lines
  1. Configuration file - BPQCFG.TXT
  2.  
  3.  
  4.  
  5. PORTS Section.
  6.  
  7.  
  8. This section of the configuration file defines the links from the switch
  9. to the outside world. These will normally be radio links, but could also
  10. be a link to another computer running another copy of the switch, or similar
  11. software (eg NOS).
  12.  
  13. Please note that there is no relationship between the 'Virtual' COM ports
  14. defined in the TNCPORT section, which are used by the BBS or other program
  15. running abouve the switch, and these external links. You may use your 
  16. 'real' COM1 port to connect to a KISS TNC, even if you have defined a 
  17. 'virtual' COM1 in the TNCPORT section. 
  18.  
  19.  
  20. There are two basic classes of links supported by the switch. One uses 
  21. normal ASYNC ports to communicate with TNCs running in KISS mode, and the
  22. other uses special HDLC cards which fit inside the PC, and interface to
  23. the radio via either an inbuilt or external  modem. Those currently supported
  24. are the PacCom PC120, DRSI PC-PA, Thor RLC100, Baycom USCC-Karte and
  25. OptoPcSCC.
  26.  
  27.  
  28. Interrupt levels may be shared by any cards with suitable hardware.
  29. Examples are all but the earliest DRSI cards, and a MS400 ASYNC card 
  30. modified as described by AA4RE in his MBBIOS documentation. However
  31. there is a significant overhead in using the shared interrupt feature
  32. - try to use it on relatively low speed links, and watch out for TX
  33. underruns/RX overuns.
  34.  
  35.  
  36. Each port is defined by a set of statements of the form:
  37.  
  38.  
  39. PORT
  40.  
  41.     PARAM=VALUE
  42.     ..
  43.     ..
  44.  
  45. ENDPORT
  46.  
  47.  
  48. Samples of various configurations are given later, but the full list
  49. of PARAM values supported is given below
  50.  
  51.  
  52. PORTNUM=n    
  53.  
  54.     Number for use in PORTS display, connects, etc. Default is next
  55.     sequential number.
  56.  
  57. ID=text string *
  58.  
  59.     Up to 30 chars, appears on PORTS display
  60.  
  61. TYPE=ASYNC/DRSI/PC120/RLC100/QUAD/INTERNAL/EXTERNAL/BAYCOM/PA0HZP *
  62.  
  63.     Hardware type.
  64.  
  65.     ASYNC is for a normal ASYNC card, or a shared interrupt card 
  66.     such as the MS400
  67.  
  68.     PC120, DRSI, RLC100, BAYCOM, PA0HZP are the internal HDLC cards,
  69.     the first two support up to two channels, the others up to 4.
  70.  
  71.     QUAD is the Quadram Quadport, which allows up to 5 async links.
  72.     This version only supports a single Quadport. See later section
  73.     for setup details.
  74.  
  75.     INTERNAL defines a 'loopback' port - anything sent on it will be
  76.     received. Intended to allow KISS applications (eg TCP/IP) to talk
  77.     to the switch.
  78.  
  79.     EXTERNAL defines a user-supplied hardware driver.
  80.  
  81.  
  82. PROTOCOL=HDLC/KISS/NETROM *
  83.  
  84.     Protocol to be used on the link.
  85.  
  86.     NETROM is to connect to the async port of a real NETROM  
  87.     KISS is to connect to a KISS TNC
  88.  
  89.  
  90. IOADDR=xxxH *
  91.  
  92.     The base I/O address for the card. In hex, H is needed
  93.  
  94.  
  95. INTLEVEL=n *
  96.  
  97.     The interrupt level to be used. Any spare level may be used, up to
  98.     7 on an 8 bit machine, or 15 on a 16 bit machine. More than one card
  99.     may share a level if the hardware has the necessary logic. Also used
  100.     to define the software interrupt for EXTERNAL drivers.
  101.  
  102.  
  103. SPEED=nnnn *
  104.  
  105.     The radio speed for HDLC cards, or the async link speed for KISS
  106.     and NETROM links. If set to zero, the modem must supply a 1x clock. 
  107.     (TXC on RTXC pin, RXC on TRXC pin.)
  108.  
  109.  
  110. CHANNEL=A/B/..*
  111.  
  112.     Selects port on HDLC cards, dual port KISS (eg KPC4) or Multidropped KISS
  113.  
  114.  
  115. BBSFLAG=NOBBS
  116.  
  117.     Stops direct connects to the BBS on this port.
  118.  
  119.  
  120. QUALITY=nnn *
  121.  
  122.     Default quality for nodes heard on this port. Set to zero to suppress
  123.     all level 3/4 activity (including NODES broadcasts) on this port.
  124.  
  125.  
  126. MAXFRAME=n *
  127.  
  128.     Maximum outstanding frames. 
  129.  
  130.  
  131. TXDELAY=nnn *
  132.  
  133.     TX Keyup delay in milliseconds
  134.  
  135.  
  136. SLOTTIME=100 *
  137.  
  138.     CSMA interval timer (milliseconds)
  139.  
  140.  
  141. PERSIST=nnn *
  142.  
  143.     'Probability to transmit' value (1-255)
  144.  
  145.  
  146. FULLDUP=0/1
  147.  
  148.     Passed on to TNC if using KISS. Used to allow transmission whilst DCD
  149.     is active on HDLC cards, and to allow connection of a NETROM cluster
  150.     via a diode matrix.
  151.  
  152.  
  153. SOFTDCD=0/1
  154.  
  155.     If set to 1, system uses the detection of a valid frame to indicate that
  156.     the channel is busy, rather than the DCD signal from the modem. Used
  157.     only for HDLC cards.
  158.  
  159.  
  160. TXTAIL=nnnn
  161.  
  162.     TXTAIL timer in ms. Used only by KISS TNCs. If running on HF at 300 baud,
  163.     the default is probably too short. If others have trouble copying your
  164.     frames, try a value of 50 - 100.
  165.  
  166.  
  167. FRACK=nnnn *
  168.  
  169.     Level 2 timout in milliseconds
  170.  
  171.  
  172. RESPTIME=nnnn *
  173.  
  174.     Level 2 delayed ack timer in milliseconds
  175.  
  176.  
  177. RETRIES=n *
  178.  
  179.     Level 2 maximum retry value
  180.  
  181.  
  182. PACLEN=nnn *
  183.  
  184.     Default maximum packet length for this port
  185.  
  186.  
  187. CWID=CALL
  188.  
  189.    Only used on HDLC cards. CWID is sent every 29 mins.
  190.  
  191.  
  192. CWIDTYPE=ONOFF
  193.  
  194.    Send CWID using ON-OFF Keying. Without this param, the CWID will be sent
  195.    using normal modem tones. This is fine for low speed links, but faster
  196.    modems (eg the G3RUH) include scramblers which make it impossible to read
  197.    the CW. Note that the TX must have a pretty fast keying characteristic
  198.    to work with ON-OFF keying - certainly < 20mS.
  199.  
  200.  
  201. PORTCALL=CALL
  202. PORTALIAS=ALIAS
  203.  
  204.     Additional callsign/alias for level 2 connects to the node for this port.
  205.     Should not be the same as BBSCALL
  206.  
  207.  
  208. ALIAS_IS_BBS=0/1
  209.  
  210.     If set then PORTCALL and PORTALIAS access the BBS instead of the node. 
  211.  
  212.  
  213. VALIDCALLS=CALLS
  214.  
  215.     Up to about 40 callsigns, separated by single commas. If present, only
  216.     stations in the list will be allowed to connect to you on this port.
  217.     The SSID should not be specified, and multiple VALIDCALLS lines may be 
  218.     included. End all but the last line with commas. The total length of the
  219.     list, including commas, is 256 bytes.
  220.  
  221.  
  222. MINQUAL=NNN
  223.  
  224.     Defines the minimum quality for a destination to be included in a
  225.     'Nodes' broadcast on this port.
  226.  
  227. QUALADJUST=NNN
  228.  
  229.     Percentage to reduce the quality of a NODE in the NODES broadcast, if
  230.     the best neighbour is on the same port as the broadcast. Designed to
  231.     improve throughput if more than one channel is available, by discouraging
  232.     routes which cause a node to send a packet on the same port that it
  233.     received it on.
  234.  
  235.  
  236. DIGIFLAG=0/1/255
  237.  
  238.     Digipeat control flag for this port. 0 = dont digi, 1 = digi everything,
  239.     255 = digi UI frames only
  240.  
  241.  
  242. DIGIPORT=N
  243.  
  244.     Port to send digied frames on. Zero means the port it was received on,
  245.     any other number means send on that port. This is intended mainly to
  246.     allow a BBS on another machine, connected via a wire link, to send out
  247.     'MAIL FOR' messages.
  248.  
  249.  
  250. USERS=N
  251.  
  252.     This limits the number of L2 sessions to the supplied number. Zero means
  253.     no limit. The limit applies to all L2 sessions (even those with other
  254.     nodes), but is only checked for incoming connects (ie you can make
  255.     outgoing connects even when the limit is reached). Intended mainly to
  256.     control the number of users on busy user access ports (especially 2m).
  257.  
  258.  
  259. UNPROTO=
  260.  
  261.     Unproto destination and digi string for this port. Use commas between
  262.     calls, and dont include the VIA.
  263.  
  264.  
  265. L3ONLY=0/1
  266.  
  267.     If set, will stop users (but not HOST sessions) issuing downlink
  268.     connects on this port. 
  269.  
  270.  
  271. INTERLOCK=n
  272.  
  273.     Allows groups of ports to be defined which will not transmit at the same
  274.     time. A value of zero indicates no locking, if any other value is specifed
  275.     the code will make sure that no two ports with the same value can transmit
  276.     at the same time. Only valid on HDLC cards.
  277.  
  278.  
  279. TXPORT=n    
  280.  
  281.     Allows frames for this port to be transmitted on a different port.
  282.     This is for use when you are operating a central node, with a single
  283.     transmitter, and a number of receivers.
  284.  
  285.  
  286. MHEARD=Y/N
  287.  
  288.     Enables or disables the MHEARD function on this port. There is a slight
  289.     overhead in maintaining the MHEARD list, so if it is not needed (eg on
  290.     an internode port) it may be disabled. Default is enabled.
  291.  
  292.  
  293. KISSOPTIONS=POLLED,CHECKSUM,ACKMODE,SLAVE
  294.  
  295.     These select my extended KISS mode.
  296.     
  297.     These extended KISS options are supported by my BPQKISS EPROM for
  298.     the TNC2 and clones, and by special EPROMS for the KPC2, KPC4 and
  299.     KAM, available from Kantronics.
  300.  
  301.     POLLED selects multi-dropped mode, where the TNC only
  302.     transmits when requested (Polled) by the PC. This allows
  303.     several TNCs to share an async port without any risk of
  304.     collisions.
  305.     
  306.     CHECKSUM selects a mode where a checksum byte is appended
  307.     to each data message, and checked by the other end. This
  308.     reduces the risk of data corruption if errors occur on the
  309.     link from PC to TNCs. It may be used on its own, but should
  310.     always be used if POLLED mode is selected.
  311.     
  312.     ACKMODE enables the transmission of 'ACK required' frames.
  313.     These cause the TNC to send a reply when the frame has been
  314.     transmitted. This will improve link performance by avoiding
  315.     the possibility of a retry being sent before the original
  316.     frame has even left the TNC. This mode should always be used
  317.     if the TNC support it.
  318.     
  319.     SLAVE allows a PC to be multidropped along with one or more
  320.     KISS TNCs on a multidropped link. If you use SLAVE, you shouldn't
  321.     set POLLED, and you shouldn't use ACKMODE on either end. 
  322.  
  323.  
  324.  
  325. Parameters marked with a * must be included, the rest are optional. The 
  326. validation is not good, and defaults are generally zero, so if you miss 
  327. out any of the essential ones, odd things may well happen!
  328.  
  329.  
  330.  
  331. Sample PORT Configurations:
  332.  
  333.  
  334. 1. 2 Port DRSI card set for IO addr = 300h, int level 5
  335.  
  336.  
  337. PORT
  338.     ID=144.650 MHz 1200 Baud
  339.     TYPE=DRSI
  340.     PROTOCOL=HDLC
  341.     IOADDR=300H
  342.     INTLEVEL=5
  343.     SPEED=1200
  344.     CHANNEL=A
  345.     QUALITY=10
  346.     MAXFRAME=1
  347.     TXDELAY=500
  348.     SLOTTIME=100
  349.     PERSIST=64
  350.     FULLDUP=0
  351.     SOFTDCD=0
  352.     FRACK=7000
  353.     RESPTIME=2000
  354.     RETRIES=10
  355.     PACLEN=120
  356.     CWID=G8BPQ
  357.  
  358. ENDPORT
  359. ;
  360. PORT
  361.     ID=432.675 MHz 1200 Baud
  362.     TYPE=DRSI
  363.     PROTOCOL=HDLC
  364.     IOADDR=300H
  365.     INTLEVEL=5
  366.     SPEED=1200
  367.     CHANNEL=B
  368.     BBSFLAG=NOBBS            ; IF MY BBS LICENCE IS ONLY FOR 2M
  369.     QUALITY=10
  370.     MAXFRAME=1
  371.     TXDELAY=500
  372.     SLOTTIME=100
  373.     PERSIST=64
  374.     FULLDUP=0
  375.     SOFTDCD=0
  376.     FRACK=6000
  377.     RESPTIME=1500
  378.     RETRIES=10
  379.     PACLEN=120
  380.     CWID=G8BPQ
  381.     PORTCALL=G8BPQ
  382.     PORTALIAS=NOTTM
  383. ;
  384. ENDPORT
  385.  
  386.  
  387. 2. Standard KISS TNC on primary ASYNC card. (COM1). To use the secondary
  388.    ASYNC card (COM2), change IOADDR to 2F8H, and the INTLEVEL to 3.  
  389.  
  390.  
  391. PORT
  392.     ID=144.650 Mhz 1200 Baud
  393.     TYPE=ASYNC
  394.     PROTOCOL=KISS
  395.     IOADDR=3F8H
  396.     INTLEVEL=4
  397.     SPEED=9600
  398.     CHANNEL=A
  399.     QUALITY=10
  400.     MAXFRAME=2
  401.     TXDELAY=500
  402.     SLOTTIME=100
  403.     PERSIST=64
  404.     FULLDUP=0
  405.     FRACK=7000
  406.     RESPTIME=2000
  407.     RETRIES=10
  408.     PACLEN=120
  409.  
  410. ENDPORT
  411.  
  412. The second port of a multiport TNC (Such as the KAM or KPC 4) is defined as
  413. follows:
  414.  
  415.     ID=432.675 Mhz 1200 baud
  416.     TYPE=ASYNC
  417.     PROTOCOL=KISS
  418.     IOADDR=3F8H
  419.     INTLEVEL=4
  420.     SPEED=2400
  421.     CHANNEL=B
  422.     QUALITY=10
  423.     MAXFRAME=2
  424.     TXDELAY=500
  425.     SLOTTIME=100
  426.     PERSIST=64
  427.     FULLDUP=0
  428.     FRACK=7000
  429.     RESPTIME=2000
  430.     RETRIES=10
  431.     PACLEN=120
  432.     QUALADJUST=5
  433.  
  434. ENDPORT
  435.  
  436.  
  437.  
  438. 3. Quadram Quadport.
  439.  
  440. The Quadram Quadport card supports up to 5 (yes I know it says quadport!!)
  441. async ports. This version only supports one card - if anyone needs more,
  442. let me know. You do not need to define all ports, but you must start with
  443. the first, and not leave any gaps.
  444.  
  445. The card should be configured with first port at 280h, and software 
  446. selectable interrupts (3 or 4 may be used)
  447.  
  448. The card will support KISS TNCS (either normal, or KPC4 type dual port), or
  449. NETROM links (or a combination of both). 
  450.  
  451.  
  452. The following sample config file is for a Dual Port KPC4 on channel 1,
  453. a normal KISS TNC on channel 2, and a NETROM async link on channel 3.
  454.  
  455.  
  456. PORT
  457.     ID=KPC4 PORT 1
  458.     TYPE=QUAD
  459.     PROTOCOL=KISS
  460.     IOADDR=280H
  461.     INTLEVEL=3
  462.     SPEED=2400
  463.     CHANNEL=A
  464.     QUALITY=10
  465.     MAXFRAME=2
  466.     TXDELAY=500
  467.     SLOTTIME=100
  468.     PERSIST=64
  469.     FULLDUP=0
  470.     FRACK=7000
  471.     RESPTIME=2000
  472.     RETRIES=10
  473.     PACLEN=120
  474.  
  475. ENDPORT
  476.  
  477. PORT
  478.     ID=KPC4 PORT 2
  479.     TYPE=QUAD
  480.     PROTOCOL=KISS
  481.     IOADDR=280H
  482.     INTLEVEL=3
  483.     SPEED=2400
  484.     CHANNEL=B
  485.     QUALITY=10
  486.     MAXFRAME=2
  487.     TXDELAY=500
  488.     SLOTTIME=100
  489.     PERSIST=64
  490.     FULLDUP=0
  491.     FRACK=7000
  492.     RESPTIME=2000
  493.     RETRIES=10
  494.     PACLEN=120
  495.  
  496. ENDPORT
  497.  
  498. PORT
  499.     ID=NORMAL KISS
  500.     TYPE=QUAD
  501.     PROTOCOL=KISS
  502.     IOADDR=290H
  503.     INTLEVEL=3
  504.     SPEED=2400
  505.     CHANNEL=A
  506.     QUALITY=10
  507.     MAXFRAME=2
  508.     TXDELAY=500
  509.     SLOTTIME=100
  510.     PERSIST=64
  511.     FULLDUP=0
  512.     FRACK=7000
  513.     RESPTIME=2000
  514.     RETRIES=10
  515.     PACLEN=120
  516.  
  517. ENDPORT
  518.  
  519. PORT
  520.     ID=NETROM BACKEND
  521.     TYPE=QUAD
  522.     PROTOCOL=NETROM
  523.     IOADDR=2A0H
  524.     INTLEVEL=3
  525.     SPEED=2400
  526.     CHANNEL=A
  527.     QUALITY=10
  528.     MAXFRAME=2
  529.     TXDELAY=500        ; THESE AREN'T USED, BUT I SUGGEST  
  530.     SLOTTIME=100        ; YOU PUT THEM IN IN CASE ONE DAY
  531.     PERSIST=64        ; THEY ARE!
  532.     FULLDUP=1        ; THIS IS NOW NEEDED FOR A SINGLE NETROM
  533.                 ; TNC. SET TO 0 IF USING A DIODE MATRIX.
  534.     SOFTDCD=0
  535.     FRACK=7000
  536.     RESPTIME=2000
  537.     RETRIES=10
  538.     PACLEN=120
  539.  
  540. ENDPORT
  541.  
  542.  
  543. 4. Baycom USCC.
  544.  
  545. This card has 4 ports, two running at 1200 (Ports A and B), one
  546. TTL port (Port C), and one G3RUH compatible 9600 bps port (Port D).
  547. The configuration is similar to the DRSI, except that port D should
  548. have SPEED=0 (Not SPEED=9600). 
  549.  
  550.  
  551. John Wiseman, G8BPQ
  552. 13/9/93
  553.